/*
    Copyright 1996-2008 Ariba, Inc.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

    $Id: //ariba/platform/ui/widgets/ariba/ui/widgets/TopFrameRedirect.java#2 $
*/

package ariba.ui.widgets;

import ariba.ui.aribaweb.core.AWComponent;
import ariba.ui.aribaweb.core.AWRequestContext;
import ariba.ui.aribaweb.core.AWSessionRestorationErrorPage;

// subclassed by AMNE ANRequisitioning/ARPunchoutSupplierFrameRedirect
public class TopFrameRedirect extends AWComponent implements AWSessionRestorationErrorPage
{
    public static final String PageName = "TopFrameRedirect";
    private String _url;
    private AWComponent _nextPage;

    public boolean shouldCachePage ()
    {
        return (_nextPage != null) ? true : false;
    }

    protected boolean allowDeferredResponse ()
    {
        return false;
    }

    public void setUrl (String urlString)
    {
        _url = urlString;
    }

    public String url ()
    {
        return _url;
    }

    public void setNextPage (AWComponent component)
    {
        _nextPage = component;
    }

    public AWComponent nextPage ()
    {
        session().clearAllPageCaches();
        // reset the frameName to the TopFrameName so that all subsequent operations
        // will be done against the top frame's pageCache.
        requestContext().setFrameName(AWRequestContext.TopFrameName);
        return _nextPage;
    }
}
